home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / diskutil / diskedit.lzh / DISKEDIT.DOC next >
Text File  |  1985-11-20  |  15KB  |  597 lines
  1.  
  2. DiskEdit Version 1.0
  3.   
  4.    DiskEdit  is  a disk editor for the Atari  520  ST.  DiskEdit 
  5. allows you to peek and poke around your disks in file mode or BIOS 
  6. sector mode .  The ability to view and modify the disk using XBIOS 
  7. (hardware) parameters is also supported. DiskEdit may also work on 
  8. the 1040 ST however since I only own a 520 ST, I wouldn't know. 
  9.  
  10.      DiskEdit  was  developed rather cheaply  from  a  development 
  11. tools perspective. It was written in 68000 assemblers using the A-
  12. Seka  assembler from Kuma.   The documentation was prepared  using 
  13. 1st  Word and the header screen was created using doodle.prg  both 
  14. of  which were included with the purchase of the 520 ST.  The Seka 
  15. assembler was purchased for approximatly $35.00 through Antic. 
  16.  
  17.      The  reason  I put DiskEdit  in the public domain  was  so  I 
  18. could  have a clear conscience the next time I download  a  public 
  19. domain utility.
  20.  
  21.      Version  1.0 of DiskEdit is a bare-bones  version  supporting 
  22. only the BIOS sector mode of operation.  I have tested it by using 
  23. it, however as with most programs, it may still be hiding a bug or 
  24. two.  If you should uncover any bugs please inform me so I may fix 
  25. them  and save others the trouble,  but please,  no threatening or 
  26. obscene phone calls as I get turned-on rather easily.
  27.  
  28.      I may usually be reached evenings at 305-488-0721 or  through 
  29. BIX mail as 'kks'. Good luck.
  30.  
  31.  
  32.                Ken Smith
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                              DiskEdit
  70.                              ========
  71.  
  72.  
  73.  
  74.  
  75.          A Public Domain Disk Editor for the Atari 520 ST
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.      By 
  123.         Ken Smith (kks)
  124.         2/21/87
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                         Table of Contents
  137.                         =================
  138.  
  139.  
  140. Section                                                     Page
  141. ----------------------------------------------------------------
  142.  
  143. 1.0    Introduction                 ........................ 1
  144.  
  145. 2.0    Operation                    ........................ 1
  146.  
  147. 3.0    Screen Layout                ........................ 1
  148. 3.1    Hex Data Area                ........................ 1
  149. 3.2    ASCII Data Area              ........................ 2
  150. 3.3    Sector Number Area           ........................ 2
  151. 3.4    Error Line                   ........................ 2
  152. 3.5    25th Line                    ........................ 2
  153.  
  154. 4.0    General Usage                ........................ 2
  155.  
  156. 5.0    Function Key Usage           ........................ 3
  157. 5.1    Help (F1)                    ........................ 3
  158. 5.2    File Mode (F2)               ........................ 3
  159. 5.3    BIOS Sector Mode (F3)        ........................ 3
  160. 5.4    XBIOS Mode (F4)              ........................ 3
  161. 5.5    Directory Mode (F5)          ........................ 3
  162. 5.6    Write Sector to Disk (F6)    ........................ 3
  163. 5.7    Display Next Sector (F7)     ........................ 4
  164. 5.8    Display Previous Sector (F8) ........................ 4
  165. 5.9    Extra Options Menu (F9)      ........................ 4
  166. 5.10   Return to Desktop (F10)      ........................ 4
  167.  
  168. 6.0    Direct Sector Access         ........................ 4
  169. 6.1    Error Handling               ........................ 5
  170.  
  171. Figure 1                            ........................ 6
  172.   
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. 1.0 Introduction
  203.  
  204.      DiskEdit is a diskette editor for the Atari 520 ST. Though it 
  205. was  developed on and for the Atari ST line of computers,  it uses 
  206. no GEM specific functions and may be ported rather easily to other 
  207. 68000 based machines.
  208.  
  209.      Three  files are supplied,  DiskEdit.tos the executable file, 
  210. DiskEdit.doo the header file and DiskEdit.doc the user manual. The 
  211. header  file and user manual are not necessary and may be  removed 
  212. if  disk  space is scarce.  Monochrome owners may have  to  remove 
  213. DiskEdit.doo in order to avoid screen RAM problems. 
  214.  
  215.      To  run  DiskEdit simply double-click DiskEdit.tos  from  the 
  216. desktop or enter DiskEdit.tos from the command shell,  etc.  etc.. 
  217. DiskEdit  takes no parameters and should run in medium  resolution 
  218. however monochrome may also work. 
  219.  
  220.  
  221. 2.0 Operation
  222.  
  223.      When  DiskEdit  is  first  loaded it  attempts  to  read  the 
  224. DiskEdit.doo  header file from the default drive into  screen  RAM 
  225. (which  is  assumed  to  be located at  address  $78000  hex).  If 
  226. DiskEdit can't find the file DiskEdit.doo on the default drive  in 
  227. the  current directory or if a read error occurs  while  accessing 
  228. this file,  DiskEdit displays a warning message.  The user is then 
  229. prompted  to press any key to continue.  Once a key is pressed the 
  230. CRT  is  cleared  and the BIOS sector mode  screen  is  displayed. 
  231. DiskEdit  then attempts to read (BIOS) sector 0 from  the  default 
  232. drive.  If  the  read  is successfull then the first half  of  the 
  233. sector  is dislayed.  If an error occurs the user is informed  and 
  234. the  contents of the memory buffer is displayed instead.  This  is 
  235. the  worst  problem  that  could happen  as  far  as  DiskEdit  is 
  236. concerned  because  the sector buffer is in an  unknown  state.  A 
  237. successfull  write at this time will almost certainly  trash  your 
  238. disk.  It  is recommended that you first find a good sector before 
  239. proceeding. This may be accomplished by repeatedly pressing the F7 
  240. key until a valid sector read occurs.
  241.  
  242.  
  243. 3.0 Screen Layout
  244.  
  245.      The basic screen design consists of five areas as depicted in 
  246. figure 1.  Please note only half of the sector is displayed at any 
  247. given time. 
  248.  
  249.  
  250. 3.1 Hex Data Area
  251.  
  252.      The hex data area (figure 1,  section A) is where the current 
  253. sector  data is dislayed and modified in hexadecimal format.  This 
  254. area  is divided into 128 word (16 bit) fileds.  These 128  fields 
  255. are  organized 8 fields per line by 16 lines.  Entering any  valid 
  256. hex  nibble  while  in this area will  modify  the  sector  memory 
  257. buffer.
  258.  
  259.  
  260.                                     1    
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. 3.2 ASCII Data Area
  269.  
  270.      The  ASCII  data  area (figure 1,  section B)  is  where  the 
  271. current  sector data is displayed as ASCII characters.  Hex values 
  272. greater  than  7F (128 decimal) or less than 21 (decimal  33)  are 
  273. displayed  as  periods  (".").   As  might  be  expected,  the  16 
  274. characters  to  the right are the ASCII representation of  the  16 
  275. bytes  displayed to the left in the hex data area.  Modifying data 
  276. in the ASCII area is currently not supported.  The ASCII data area 
  277. is organized as 16 characters by 16 lines. 
  278.  
  279.  
  280. 3.3 Sector Number Area
  281.  
  282.      The  sector  number area (figure 1,  section C) is where  the 
  283. current sector number is displayed and modified. The sector number 
  284. is always displayed as four hex nibbles and represents the  sector 
  285. number  of the data currently in the buffer.  Direct access to any 
  286. sector is achieved by modifying this field.
  287.  
  288.  
  289. 3.4 Error Line
  290.  
  291.      The  error  line (figure 1,  section D) is located below  the 
  292. 23rd  line (the sector number line).  Any time an error occurs the 
  293. error  code  and a prompt message is displayed on this  line.  The 
  294. user  must  then  press any key to clear off the  error  line  and 
  295. continue. 
  296.  
  297.  
  298. 3.5 25th Line
  299.  
  300.      The  25th line always displays the abbreviated names  of  the 
  301. operations associated with the various function keys.  The current 
  302. operating mode is displayed in reverese video on this line also. 
  303.  
  304.  
  305. 4.0 General Usage
  306.  
  307.      DiskEdit is a function key based system. This means that most 
  308. operations  are initiated using the function keys.  The 25th  line 
  309. shows  the  relationship  between  the  function  keys  and  their 
  310. corresponding  operations.  Some  function  keys do  nothing  when 
  311. pressed.  This  indicates  a (dead) function key which is not  yet 
  312. implemented.
  313.  
  314.      The  cursor  may  be located in one of  two  basic  areas  as